ses-ux

(0 reviews)

POST-TMF679 entitlements

This method is to provide the entitlement status of different services to SES.

URL

https://{host:port}/{context}/esintegration/v1.0/esim/entitlements

URL Param

name	type	description	required
context	string	CR - Context carries the identifier for the specfic market if it is Costa Rica	Y

name	type	description	required
Authorization	string	The credential of SES. HTTP basic authentication and OAuth access token bearer are supported.	Y
X-Correlation-ID	string	Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.	Y

cURL request

curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/ses-ux-lcr/CR/esintegration/v1.0/esim/entitlements' \
--header 'Authorization: Basic xxxxxxxxxxx' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'Content-Type: application/json' \
--data '{
    "imsi": "460019876543218",
    "user-id": "user A",
    "msisdn": "50661430059",
    "device-category": "android-whitelist",
    "msisdn-category": "native",
    "operator-id": "operator-A",
    "entitlement-names": ["iphone-plan-transfer"]
}'

Definitions

Field	Type	Description	Required
imsi	string	The IMSI of the end user.	N*
user-id	string	The subscriber’s unique identity in the carrier.	N*
msisdn	string	The MSISDN of the end user.	Y
device-category	string	The type of the device sending the request. Available Values: regular, andriod-whitelist	N
msisdn-category	string	The type of the MSISDN for entitlement checking. Available Values: native, virtual	N
operator-id	string	The identity of the operator associated to the subscriber’s phone number.	N
entitlement-names	array	Entitlement names. BSS allowed values: VoLTE, VoWiFi, & iPhone-plan-transfer; for Magnolia, it is always iPhone-plan-transfer	Y

Note: At least one of the user-id or imsi must be present in the request. Either check entitlement by user-id or by imsi. These two parameters are mutually exclusive.

Success Response

200- ok

{
    "status": 6000,
    "response": [
        {
            "entitlement-name": "iphone-plan-transfer",
            "entitlement-status": 6100
        }
    ]
}

Definition

Field	Type	Description
status	integer	Status code. Available status codes: 6000: STATUS_SUCCESS. Action succeeded! 6005: STATUS_TEMPORARY_FAILURE. System failure!
response	array	The array of entitlement status per each service
entitlement-name	string	The entitlement name in the request.
entitlement-status	Integer	Status code indicating entitlement status. Available status codes: 6100: STATUS_ENABLED_ENTITLEMENT. Entitlement is enabled for subscriber! 6101: STATUS_DISABLED_ENTITLEMENT. Entitlement is disabled for subscriber! 6102: STATUS_INVALID_ENTITLEMENT. Entitlement is not recognized! 6103: STATUS_PROVISIONING_ENTITLEMENT. Entitlement provisioning in progress! Note: 6103 is coming for VoLTE spec. 6104: STATUS_BIZACCT_ENTITLEMENT. Entitlement is disabled for business accounts! 6105: STATUS_PPACCT_ENTITLEMENT. Entitlement is disabled for prepaid accounts! 6106: STATUS_INCOMPATIBLE_ENTITLEMENT. Entitlement is not allowed for account!

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
"error": "Invalid_Request",
"error_description": "The request is invalid, <Specific invalid parameter>."
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
"error": "Entitlement_Not_Found",
"error_description": "The entitlement not found for the specified parameters"
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
"error": "Internal Server Error",
"error_description": "Error when checking the entitlements, <Specific error description>."
}